<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ResourceController xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/com/cerner/system/rest/resource/organizer/ResourceController.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2009 Cerner Corporation.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.html" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.html</a></em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * Contributors:</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *    Cerner Corporation - initial API and implementation</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> */</em>
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">package</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment">/**</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * API to navigate hierarchical URIs, access and modify the representation of</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * its associated resource, or delete it and all of its child resources. Objects</em>
<a name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * of this type should be instantiated via</em>
<a name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * {@link ResourceOrganizer#resource(java.net.URI)}.</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * </em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * @author Alex Horn</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * @param &lt;E&gt; class type of resource representation</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * @see ResourceOrganizer#resource(java.net.URI)</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> */</em>
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> ResourceController&lt;E&gt; {
<a name="24" href="#24">24</a>  
<a name="25" href="#25">25</a>    <em class="jxr_javadoccomment">/**</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">   * Obtain the URI with which this {@link ResourceController} is associated.</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">   * </em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment">   * @return uniform resource identifier of this resource controller</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">   */</em>
<a name="30" href="#30">30</a>    <strong class="jxr_keyword">public</strong> java.net.URI uri();
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>    <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">   * Dereference the parent resource controller. The return value is {@code</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   * null} if the {@link #uri() URI} is opaque or if its path is the root.</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">   * </em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">   * @return parent resource controller or {@code null} if there is none</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   */</em>
<a name="38" href="#38">38</a>    <strong class="jxr_keyword">public</strong> ResourceController&lt;E&gt; parent();
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>    <em class="jxr_javadoccomment">/**</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * Obtain the resource representation of type {@code &lt;E&gt;} that is managed by</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * this resource controller. The return value is {@code null} if the resource</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   * does not exist or it has no representation.</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">   * </em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">   * @return resource representation or {@code null} if there is none</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   */</em>
<a name="47" href="#47">47</a>    <strong class="jxr_keyword">public</strong> E get();
<a name="48" href="#48">48</a>  
<a name="49" href="#49">49</a>    <em class="jxr_javadoccomment">/**</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   * Save the provided representation to the underlying data structure</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   * maintained by the service provider. The representation object must be</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">   * thread-safe if the {@link ResourceOrganizer} is shared by multiple</em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment">   * processes or threads.</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * </em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * @param representation non-null object that represents the content</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   *          associated with the {@link #uri() resource URI}</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   * @throws IllegalArgumentException if the representation argument is {@code</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   *           null}</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * @return boolean {@code true} if a new resource was created, {@code false} if</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   *         an existing resource was replaced by this operation</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   */</em>
<a name="62" href="#62">62</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> put(E representation);
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>    <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * Remove this resource and all of its child resources.</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   * </em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">   * @return boolean {@code true} if an existing resource was removed, {@code</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">   *         false} if the resource did not exist</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   */</em>
<a name="70" href="#70">70</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> delete();
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>    <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * Compare two {@link ResourceController} objects for equality. They are equal</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * if their {@link #uri() URIs} are {@link java.net.URI#equals(Object) equal}.</em>
<a name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   * </em>
<a name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   * @param object object that should be compared for equality</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">   * @return boolean {@code true} if both {@link ResourceController#uri()} match,</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">   *         {@code false} if the resource controllers are responsible for</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">   *         different URIs</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">   */</em>
<a name="81" href="#81">81</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object object);
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>    <em class="jxr_javadoccomment">/**</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * Compute the hash code of a {@link ResourceController} from its</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * {@link #uri() URI}.</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * </em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   * @return hash code of the resource controller</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">   */</em>
<a name="89" href="#89">89</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode();
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>    <em class="jxr_javadoccomment">/**</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   * Get a debugger-friendly representation of this {@link ResourceController}</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   * </em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * @return lexical representation of the {@link #uri() URI}</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   */</em>
<a name="96" href="#96">96</a>    <strong class="jxr_keyword">public</strong> String toString();
<a name="97" href="#97">97</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

